Embabel Agent Documentation/com.embabel.common.ai.prompt

Package-level declarations

Types

class CurrentDate(formatter: DateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd")) : PromptContributor

Expose the current date as a prompt contributor. Added by Embabel agent platform.

class KnowledgeCutoffDate(val date: LocalDate, formatter: DateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM")) : PromptContributor

Well-known prompt contributor for knowledge cutoff date. Valuable if the knowledge cutoff date is known. Added by Embabel agent platform.

PromptContribution

data class PromptContribution(val content: String, val location: PromptContributionLocation = PromptContributionLocation.BEGINNING, val role: String? = null)

Contribution to a prompt

PromptContributionLocation

enum PromptContributionLocation : Enum<PromptContributionLocation>

Where should the prompt go? Can be used to map into system messages or other locations.

PromptContributor

interface PromptContributor : PromptElement

Contributor to a prompt. Contributors may be put in a system message or elsewhere depending on location. Only the contribution() method must be implemented, but implementations are free to provide location and role data via overriding those properties.

PromptContributorConsumer

interface PromptContributorConsumer

PromptElement

interface PromptElement

Contributor to a prompt. Returns a PromptContribution: subtypes may differ in how they compute this--for example, some may use a fixed value, whereas others may compute based on data. PromptContributions may be put in a system message or elsewhere depending on location.